PaymentAddress: country property

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The country read-only property of the PaymentAddress interface is a string identifying the address's country using the ISO 3166-1 alpha-2 standard. The string is always in its canonical upper-case form.

Some examples of valid country values: "US", "GB", "CN", or "JP".

Value

A string which contains the ISO3166-1 alpha-2 code identifying the country in which the address is located, or an empty string if no country is available, which frequently can be assumed to mean "same country as the site owner."

Usage notes

If the payment handler validates the address and determines that the value of country is invalid, a call to PaymentRequestUpdateEvent.updateWith() will be made with a details object containing a shippingAddressErrors field. That field contains an object whose country property is a string indicating the validation error that occurred and, if possible, suggestions on how to fix it.

Browser compatibility

See also